KikuGie's Commons/dev.kikugie.commons.result

Package-level declarations

Types

Either

sealed interface Either<L, R>

Represents one of the possible values.

KOptional

@JvmInline

value class KOptional<T>

Optional implementation that allows holding null values.

Functions

invalidArg

inline fun invalidArg(message: Any): Nothing

invalidIndex

inline fun invalidIndex(message: Any): Nothing

notNullResult

inline fun <T : Any> notNullResult(value: T?): Result<T>

inline fun <T : Any> notNullResult(value: T?, message: () -> String): Result<T>

Converts the given value to a Result, that stores a NullPointerException when the value is null.

unsupportedOperation

inline fun unsupportedOperation(message: Any): Nothing

Inherited functions

fold

inline fun <L, R, O> Either<L, R>.fold(ifLeft: (L) -> O, ifRight: (R) -> O): O

inline fun <T, R> KOptional<T>.fold(ifPresent: (T) -> R, ifEmpty: () -> R): R

Transforms the value with the ifPresent function if it's present, or the one provided by ifEmpty otherwise.

getOrDefault

inline fun <T> KOptional<T>.getOrDefault(default: T): T

Returns the value if it's present, or default otherwise.

getOrElse

inline fun <T> KOptional<T>.getOrElse(action: () -> T): T

Returns the value if it's present, or the one provided by the action otherwise.

ifEmpty

inline fun <T> KOptional<T>.ifEmpty(action: () -> Unit): KOptional<T>

Executes the provided action if the value is absent.

ifLeft

inline fun <L, R> Either<L, R>.ifLeft(action: (L) -> Unit): Either<L, R>

ifPresent

inline fun <T> KOptional<T>.ifPresent(action: (T) -> Unit): KOptional<T>

Executes the provided action if the value is present.

ifRight

inline fun <L, R> Either<L, R>.ifRight(action: (R) -> Unit): Either<L, R>

inherit

fun <T : Throwable> T.inherit(other: Throwable): T

leftOrDefault

inline fun <L, R> Either<L, R>.leftOrDefault(default: L): L

leftOrElse

inline fun <L, R> Either<L, R>.leftOrElse(action: (R) -> L): L

leftOrNull

inline fun <L, R> Either<L, R>.leftOrNull(): L?

leftOrThrow

inline fun <L, R> Either<L, R>.leftOrThrow(): L

map

inline fun <T, R> KOptional<T>.map(action: (T) -> R): KOptional<R>

Transforms the value with the provided action if it's present.

mapException

inline fun <T> Result<T>.mapException(transform: (Throwable) -> Throwable): Result<T>

Transforms the result exception if it's a failure, otherwise returns itself.

mapLeft

inline fun <L, R, O> Either<L, R>.mapLeft(action: (L) -> O): Either<O, R>

mapResult

inline fun <T, R> Result<T>.mapResult(transform: (T) -> Result<R>): Result<R>

If the result is successful, replaces it with the value returned by the transform operation.

mapRight

inline fun <L, R, O> Either<L, R>.mapRight(action: (R) -> O): Either<L, O>

rightOrDefault

inline fun <L, R> Either<L, R>.rightOrDefault(default: R): R

rightOrElse

inline fun <L, R> Either<L, R>.rightOrElse(action: (L) -> R): R

rightOrNull

inline fun <L, R> Either<L, R>.rightOrNull(): R?

rightOrThrow

inline fun <L, R> Either<L, R>.rightOrThrow(): R

swap

inline fun <L, R> Either<L, R>.swap(): Either<R, L>